refactor: introduce function for getting Schema Object type #10330

char0n · 2025-02-28T13:18:41Z

use function for getting schema object type/schema object type label depending on the OpenAPI version

char0n · 2025-03-06T11:35:15Z

src/core/plugins/json-schema-5-samples/fn/index.js

+
+export const getSchemaObjectTypeLabel = (label) => label
+
+export const getSchemaObjectType = (schema) => schema.type ?? "any"


To be consistent with JSON Schema 2020-12 processing, can we make the fallback type the string type?

Suggested change

export const getSchemaObjectType = (schema) => schema.type ?? "any"

export const getSchemaObjectType = (schema) => schema.type ?? "string"

Also, may I suggest to make this function safe:

Suggested change

export const getSchemaObjectType = (schema) => schema.type ?? "any"

export const getSchemaObjectType = (schema) => schema?.type ?? "string"

Preferred alternative: What if both the functions would have the following signature?

getSchemaObjectType: (schema: object) -> string getSchemaObjectTypeLabel: (schema: object) -> string

This would simplify their usage inside the code as it is now abstracted how the the type or label are computed from the schema.

Instead of

const typeLabel = fn.getSchemaObjectTypeLabel(immutableToJS(schema?.get("type")))

you'll end up having

const typeLabel = fn.getSchemaObjectTypeLabel(immutableToJS(schema))

If you further abstract and allow the functions to consume immutable along with POJO, it can look like:

const typeLabel = fn.getSchemaObjectTypeLabel(schema)

NOTE: this applies both for Draft 5 and 2020-12 functions.

char0n · 2025-03-06T11:37:12Z

src/core/plugins/json-schema-5-samples/fn/index.js

@@ -635,3 +635,7 @@ const resolver = (arg1, arg2, arg3) => [arg1, JSON.stringify(arg2), JSON.stringi
 export const memoizedCreateXMLExample = memoizeN(createXMLExample, resolver)

 export const memoizedSampleFromSchema = memoizeN(sampleFromSchema, resolver)
+
+export const getSchemaObjectTypeLabel = (label) => label


The input is type not a label.

Suggested change

export const getSchemaObjectTypeLabel = (label) => label

export const getSchemaObjectTypeLabel = (type) => type

But anyway we can make this point-free by:

import identity from "lodash/identity" export const getSchemaObjectTypeLabel = identity

char0n · 2025-03-06T13:17:56Z

src/core/components/parameter-row.jsx

-    const typeLabel = fn.jsonSchema202012.getType(immutableToJS(schema))
-    const type = fn.jsonSchema202012.foldType(immutableToJS(schema?.get("type"))) 
-    const itemType = fn.jsonSchema202012.foldType(immutableToJS(schema?.getIn(["items", "type"]))) 
+    const typeLabel = fn.getSchemaObjectType(immutableToJS(schema))


This looks a bit confusing. For getting a typeLabel we're using getSchemaObjectType. For actual type we're using getSchemaObjectTypeLabel. Shouldn't it be reversed?

…body

glowcloud · 2025-05-12T11:14:08Z

src/core/plugins/json-schema-2020-12-samples/fn/core/type.js

@@ -154,3 +155,11 @@ export const inferType = (schema, processedSchemas = new WeakSet()) => {
 export const getType = (schema) => {
  return inferType(schema)
 }
+
+export const getFoldType = (schema) => {
+  if (isImmutable(schema)) {


immutableToJS has the isImmutable check, so we should be able to skip checking it here.

Also, should we have a separate variable for the transformed schema, instead of reassigning?

Same for other places where this occurs.

src/core/plugins/json-schema-2020-12/index.js

src/core/plugins/json-schema-5/components/json-schema-components.jsx

src/core/plugins/json-schema-2020-12-samples/fn/core/type.js

src/core/plugins/json-schema-2020-12/fn.js

src/core/components/parameter-row.jsx

src/core/plugins/json-schema-5-samples/fn/index.js

glowcloud

Can we also revert the changes to unrelated files, e.g. operation-tag? If not possible, then we can leave them as is.

glowcloud · 2025-05-19T09:12:14Z

src/core/components/parameter-row.jsx

@@ -322,7 +321,7 @@ export default class ParameterRow extends Component {
            { !required ? null : <span>&nbsp;*</span> }
          </div>
          <div className="parameter__type">
-            { typeLabel }
+            { schemaObjectType }


We should be using schemaObjectTypeLabel here

Suggested change

{ schemaObjectType }

const schemaObjectTypeLabel = fn.getSchemaObjectTypeLabel(schema)

// ...

{ schemaObjectTypeLabel }

glowcloud · 2025-05-19T09:13:50Z

src/core/plugins/oas31/after-load.js

@@ -33,6 +33,8 @@ function afterLoad({ fn, getSystem }) {
        getXmlSampleSchema: fn.jsonSchema202012.getXmlSampleSchema,
        getSampleSchema: fn.jsonSchema202012.getSampleSchema,
        mergeJsonSchema: fn.jsonSchema202012.mergeJsonSchema,
+        getSchemaObjectTypeLabel: fn.jsonSchema202012.getType,


Suggested change

getSchemaObjectTypeLabel: fn.jsonSchema202012.getType,

getSchemaObjectTypeLabel: (schema) => fn.jsonSchema202012.getType(immutableToJS(schema)),

glowcloud · 2025-05-19T09:14:12Z

src/core/plugins/oas31/after-load.js

@@ -33,6 +33,8 @@ function afterLoad({ fn, getSystem }) {
        getXmlSampleSchema: fn.jsonSchema202012.getXmlSampleSchema,
        getSampleSchema: fn.jsonSchema202012.getSampleSchema,
        mergeJsonSchema: fn.jsonSchema202012.mergeJsonSchema,
+        getSchemaObjectTypeLabel: fn.jsonSchema202012.getType,
+        getSchemaObjectType: fn.jsonSchema202012.foldType,


Suggested change

getSchemaObjectType: fn.jsonSchema202012.foldType,

getSchemaObjectType: (schema) => fn.jsonSchema202012.foldType(immutableToJS(schema)?.type),

glowcloud · 2025-05-19T09:16:20Z

src/core/plugins/json-schema-2020-12-samples/index.js

@@ -42,7 +44,7 @@ const JSONSchema202012SamplesPlugin = ({ getSystem }) => {
        getXmlSampleSchema,
        getSampleSchema,
        mergeJsonSchema,
-        foldType,
+        foldType: makeFoldType,


Let's keep the signature of foldType the same when exposed through the plugin system and instead handle immutable in oas31/after-load: #10330 (comment)

glowcloud · 2025-05-19T09:16:55Z

src/core/plugins/json-schema-2020-12/fn.js

@@ -164,7 +165,7 @@ export const makeGetType = (fnAccessor) => {
    return combinedStrings || "any"
  }

-  return getType
+  return (schema, ...rest) => getType(immutableToJS(schema), ...rest)


Let's handle this in oas31/after-load: #10330 (comment)

Suggested change

return (schema, ...rest) => getType(immutableToJS(schema), ...rest)

return getType

glowcloud · 2025-05-19T09:19:53Z

src/core/plugins/json-schema-5-samples/fn/index.js

@@ -627,6 +628,37 @@ export const createXMLExample = (schema, config, o) => {
  return XML(json, { declaration: true, indent: "\t" })
 }

+const getType = (schema, processedSchemas = new WeakSet()) => {


As this is related to rendering, let's move getType and getSchemaObjectTypeLabel to fn in json-schema-5 plugin.

glowcloud · 2025-05-19T09:26:28Z

src/core/plugins/json-schema-5/components/json-schema-components.jsx

    if (schemaItemsType && schemaItemsFormat) {
      ArrayItemsComponent = getComponent(`JsonSchema_${schemaItemsType}_${schemaItemsFormat}`)
    } else if (schemaItemsType === "boolean" || schemaItemsType === "array" || schemaItemsType === "object") {
      ArrayItemsComponent = getComponent(`JsonSchema_${schemaItemsType}`)
    }

-    if (List.isList(schemaItemsType) && (foldedSchemaItemsType === "array" || foldedSchemaItemsType === "object")) {
+    if (List.isList(schemaItems.get("type")) && (schemaItemsType === "array" || schemaItemsType === "object")) {


We might need to do this to be safe here

Suggested change

if (List.isList(schemaItems.get("type")) && (schemaItemsType === "array" || schemaItemsType === "object")) {

if (List.isList(schemaItems?.get("type")) && (schemaItemsType === "array" || schemaItemsType === "object")) {

glowcloud · 2025-05-19T09:35:08Z

src/core/plugins/json-schema-5-samples/fn/index.js

+
+export const getSchemaObjectTypeLabel = (schema) => getType(immutableToJS(schema))
+
+export const getSchemaObjectType = (schema) => schema?.get("type") ?? "string"


Not sure about it but maybe we should we be handling immutable here as well?

Suggested change

export const getSchemaObjectType = (schema) => schema?.get("type") ?? "string"

export const getSchemaObjectType = (schema) => immutableToJS(schema)?.type ?? "string"

glowcloud · 2025-05-19T09:36:38Z

src/core/plugins/json-schema-5-samples/fn/index.js

 import memoizeN from "core/utils/memoizeN"
+import { immutableToJS } from "../../../utils"


Suggested change

import { immutableToJS } from "../../../utils"

import { immutableToJS } from "core/utils"

char0n requested a review from glowcloud February 28, 2025 13:18

char0n assigned robert-hebel-sb Feb 28, 2025

char0n added type: enhancement version: 5.x labels Feb 28, 2025

char0n commented Mar 6, 2025

View reviewed changes

refactor: introduce function for getting Schema Object type

c70aaaf

robert-hebel-sb force-pushed the feat/schema-object-type-func branch from 536f636 to c70aaaf Compare May 5, 2025 10:14

robert-hebel-sb added 3 commits May 5, 2025 12:24

refactor: adjust variables naming, simplify getSchemaObjectTypeLabel …

ab8ec1b

…body

refactor: abstract getSchemaObjectType logic

5e4d372

refactor: abstract getSchemaObjectTypeLabel logic

28ac129

glowcloud reviewed May 12, 2025

View reviewed changes

src/core/components/parameter-row.jsx Outdated Show resolved Hide resolved

robert-hebel-sb added 6 commits May 12, 2025 17:26

refactor: apply CR suggestions

2e2bc6d

refactor: apply CR suggestions

0057776

fix: get an array type for oas 3 definitions

8c09f02

Merge branch 'master' into feat/schema-object-type-func

0aa4e0e

chore: fix lint errors

9df7f70

fix: get array type

98988ea

robert-hebel-sb requested a review from glowcloud May 14, 2025 11:36

glowcloud reviewed May 15, 2025

View reviewed changes

src/core/plugins/json-schema-5-samples/fn/index.js Show resolved Hide resolved

src/core/plugins/json-schema-5-samples/fn/index.js Outdated Show resolved Hide resolved

refactor: unify schema utils naming

042c2a8

robert-hebel-sb requested a review from glowcloud May 16, 2025 09:44

glowcloud reviewed May 19, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor: introduce function for getting Schema Object type #10330

refactor: introduce function for getting Schema Object type #10330

char0n commented Feb 28, 2025

char0n Mar 6, 2025

char0n Mar 6, 2025 •

edited

Loading

char0n Mar 6, 2025 •

edited

Loading

char0n Mar 6, 2025

glowcloud May 12, 2025

glowcloud left a comment

glowcloud May 19, 2025

glowcloud May 19, 2025

glowcloud May 19, 2025

glowcloud May 19, 2025 •

edited

Loading

glowcloud May 19, 2025 •

edited

Loading

glowcloud May 19, 2025

glowcloud May 19, 2025

glowcloud May 19, 2025

glowcloud May 19, 2025


		export const getSchemaObjectTypeLabel = (label) => label

		export const getSchemaObjectType = (schema) => schema.type ?? "any"

-            { schemaObjectType }
+   const schemaObjectTypeLabel = fn.getSchemaObjectTypeLabel(schema)
+   // ...
+   { schemaObjectTypeLabel }

	getSchemaObjectTypeLabel: fn.jsonSchema202012.getType,
	getSchemaObjectTypeLabel: (schema) => fn.jsonSchema202012.getType(immutableToJS(schema)),

	getSchemaObjectType: fn.jsonSchema202012.foldType,
	getSchemaObjectType: (schema) => fn.jsonSchema202012.foldType(immutableToJS(schema)?.type),

	return (schema, ...rest) => getType(immutableToJS(schema), ...rest)
	return getType

	if (List.isList(schemaItems.get("type")) && (schemaItemsType === "array" \|\| schemaItemsType === "object")) {
	if (List.isList(schemaItems?.get("type")) && (schemaItemsType === "array" \|\| schemaItemsType === "object")) {

		import memoizeN from "core/utils/memoizeN"
		import { immutableToJS } from "../../../utils"

	import { immutableToJS } from "../../../utils"
	import { immutableToJS } from "core/utils"

refactor: introduce function for getting Schema Object type #10330

Are you sure you want to change the base?

refactor: introduce function for getting Schema Object type #10330

Conversation

char0n commented Feb 28, 2025

Choose a reason for hiding this comment

char0n Mar 6, 2025 • edited Loading

Choose a reason for hiding this comment

char0n Mar 6, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

glowcloud left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

glowcloud May 19, 2025 • edited Loading

Choose a reason for hiding this comment

glowcloud May 19, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

char0n Mar 6, 2025 •

edited

Loading

char0n Mar 6, 2025 •

edited

Loading

glowcloud May 19, 2025 •

edited

Loading

glowcloud May 19, 2025 •

edited

Loading